Changes between Version 4 and Version 5 of XmlRpcIntro

Timestamp:

Sep 28, 2008, 12:57:13 PM (16 years ago)

Author:

guest

Comment:

added sections on 'Languages' and 'File handling'

XmlRpcIntro

@@ -1 +1 @@
 = Introduction to OSDb =
 
-[[PageOutline(2, Sections)]]
+[[PageOutline(1-2, Sections)]]
 
 This page is aimed at developers who'd like to implement the OSDb protocol and functionality into their own applications.
@@ -21 +21 @@
 
 = Instructions =
+
  * [wiki:DevReadFirst Read this first]
  * All development testing should be pointed to: http://dev.opensubtitles.org/xml-rpc (currently offline, so use main server)
  * Main/Production server XML-RPC URL: http://www.opensubtitles.org/xml-rpc
  * Before developing let us know and we will assign/agree on useragent code for your application.
- * For languages codes, check [http://en.wikipedia.org/wiki/List_of_ISO_639-2_codes ISO639], use '''pb/pob''' for Portuguese (Brazil) - [http://www.opensubtitles.org/addons/export_languages.php Download OS languages table dump]
- * For gzip compression use function which adds no header to output, for PHP it's: [http://www.php.net/manual/en/function.gzcompress.php gzcompress]. For decompression use [http://www.php.net/gzuncompress gzdecompress].
+
+== Languages ==
+
+  The API is working with either 2 (ISO 639-1) or 3-letter (ISO 639-2) language codes depending on the implementation.
+  
+  To learn more, see the specifications and get language lists, visit:
+    * [http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes List of ISO 639-1 2-letter codes on Wikipedia]
+    * [http://en.wikipedia.org/wiki/List_of_ISO_639-2_codes List of ISO 639-2 3-letter codes on Wikipedia]
+  
+  You can also download [http://www.opensubtitles.org/addons/export_languages.php OS languages] table dump.
+
+  You should use '''pb/pob''' for Portuguese (Brazil).
 
 
+== File handling ==
+
+  When sending files (download, upload, etc.) files are usually sent as first gzipped (without header) then base64-encoded contents.
+  
+  So when trying to get the contents you should first base64-decode, then gunzip it.
+     
+  gzip compression uses a function which adds no header to output.
+
+  Here's a list of functions you can use:
+  
+  ||Programming language||Compress||Decompress||Base64 encode||Base64 decode||
+  ||PHP||[http://www.php.net/manual/en/function.gzcompress.php gzcompress]||[http://www.php.net/gzuncompress gzdecompress]||?||?||
+
+{{{
+#!html
+  <div style='color:red'>TO-DO</div>
+}}}
+
+
+----
 = XML-RPC methods =
 
@@ -64 +95 @@
 == Reporting and rating ==
   * [wiki:XmlRpcServerInfo ServerInfo] - get basic server information and statistics
+      '''struct !ServerInfo()'''
   * [wiki:XmlRpcReportMovieHash ReportMovieHash] - report wrong
   * [wiki:XmlRpcSubtitlesVote SubtitlesVote] - rate subtitles
+      '''struct !SubtitlesVote(string $token, struct('idsubtitle' => int $idsubtitle, 'score' => int $score) $vote)'''  
 
 
 == User interface ==
-  * [wiki:XmlRpcGetSubLanguages GetSubLanguages] - get support subtitle languages
+  * [wiki:XmlRpcGetSubLanguages GetSubLanguages] - get supported subtitle languages
+      '''struct !GetSubLanguages(string $language = 'en')'''
   * [wiki:XmlRpcDetectLanguage DetectLanguage] - detect language for given text
   * [wiki:XmlRpcGetAvailableTranslations GetAvailableTranslations] - get list of available translations for a client application
+      '''struct !GetAvailableTranslations(string $token, string $program)'''
   * [wiki:XmlRpcGetTranslation GetTranslation] - get given language translation file for a client application
+      '''struct !GetTranslation(string $token, string $iso639, string $format, string $program )'''
   * [wiki:XmlRpcAutoUpdate AutoUpdate] - check for latest version of a client application
+      '''struct !AutoUpdate (string $program_name)'''